filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
=======
https://api.achilles.tokend.io /v3/asset_update_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/asset_update_requests?include=asset&page[number]=2&page[limit]=15" ,
"self" : "/v3/asset_update_requests?include=asset&page[number]=1&page[limit]=15"
} }
Balance by ID Allows getting Balance with corresponding details.
path Parameters id required
string
Unique identifier of a balance
query Parameters includestring
Enum: "asset" "state"
Example: "asset"
🔒 Following relationships require an owner's or admin's signature to be included:
>>>>>>> master
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.asset]string
Filters update asset requests by asset code.
includestring
Enum: "request_details" "request_details.asset"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
<<<<<<< HEAD
404 request does not exist
get /v3/update_asset_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/update_asset_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "asset" :
{ "id" : "USD" ,
"type" : "assets"
} } , "attributes" :
{ "policies" : 12 ,
"creator_details" : { }
} } ] }
Balance List Allows getting list of balances with corresponding details.
=======
404 such a balance does not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/balances/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "value" : 1 ,
"name" : "General"
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] }
Balance List Allows getting list of balances with corresponding details.
>>>>>>> master
🔒 Admins signature is needed. If filter by asset is provided, the signature of asset's owner is also valid
query Parameters filter[asset]string
Filters balances by asset. Returns page of balances for the provided asset
filter[asset_owner]any
Filters balances by asset owner. Returns page of balances for the provided asset owner
filter[owner]string
Filters balances by owner. Returns page of balances for the provided owner
includestring
Enum: "state" "owner"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 200 Request is successfull
401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
TokenD Developer Environment
https://api.achilles.tokend.io /v3/balances
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" : [ ] ,
"links" :
{ "next" : "/v3/balances?page[number]=2&page[limit]=15" ,
"self" : "/v3/balances?page[number]=1&page[limit]=15"
} }
Balance by ID Allows getting Balance with corresponding details.
path Parameters id required
string
Unique identifier of a balance
query Parameters includestring
Enum: "asset" "state"
Example: "asset"
🔒 Following relationships require an owner's or admin's signature to be included:
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 such a balance does not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/balances/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "name" : "string" ,
"value" : 2
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] }
Converted Balances Allows getting list of balances converted to provided asset.
🔒 Either account or admin signature is needed. If filter by asset owner is provided, the signature of asset's owner is also valid
path Parameters account_id required
asset_code required
string
ID of the collection (asset to convert balances to)
query Parameters filter[asset_owner]any
Filters balances by asset owner. Returns page of balances for the provided asset owner
includestring
Enum: "asset" "states" "balance" "balance.state" "balance.asset"
Example: "states"
Relationships that may be used for the include parameter.
Responses 200 balances collection exist
401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 either account or asset to convert states doesn't exist
get /v3/accounts/{account_address}/converted_balances/{asset_code} TokenD Developer Environment
https://api.achilles.tokend.io /v3/accounts/{account_address}/converted_balances/{asset_code}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "BDLXKLLVS6UIQEDYCZKIC5222GGQLCOTHM4BWXVCBDQMJTUWUFUATV2Q" ,
"type" : "converted-balance-states" ,
"attributes" :
{ "price" : "2.331001" ,
"is_converted" : true
} , } ] }
Defines access points for fees
Calculate fee Allows calculating a fee for an account.
path Parameters asset required
string
Unique identifier of an asset
fee_type required
subtype required
amount required
string
Amount to calculate on which fee is based on
Responses 200 fee does exist and is calculated successfuly
500 internal error occured during the request processing
get /v3/accounts/{id}/calculated_fees TokenD Developer Environment
https://api.achilles.tokend.io /v3/accounts/{id}/calculated_fees
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "a343e3cbcc72928a571778f77bf2554eb5b72c79ce28bbc9d3325c60c21e5241" ,
"type" : "calculated-fee" ,
} }
Fee List Allows getting a filtered list of Fee with corresponding details.
query Parameters filter[asset]string
Filters fees by asset. Returns page of fees for the provided asset
filter[fee_type] filter[subtype] filter[account]string
Filters fees by account address. Returns only fees which explicitly contains this account in relationships.
This means that if the fee was applied exactly for this account - it would be returned in the response.
Global fees, fees for account roles and other system-wide fees would be omitted.
For example if someone's, say Bob, account has a several fees applied to itself:
first fee applied globally for all accounts for payments from 0 to 100 BTC and is 1% from the payment
second fee applied exactly to Bob's account and is 2% of the payment for amounts from 100 to 200 BTC
then we will receive only the second fee in response only it is applied to Bob's account
filter[account_role]integer
Filters fees by account role.
filter[lower_bound]integer
Filters fees by lower_bound.
filter[upper_bound]integer
Filters fees by upper_bound.
includestring
Value: "asset"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/fees
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "name" : "string" ,
"value" : 2
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/fees?include=asset&page[number]=2&page[limit]=15" ,
"self" : "/v3/fees?include=asset&page[number]=1&page[limit]=15"
} }
Defines access points to AMLAlert Reviewable Requests
AMLAlert List Allows getting a filtered list of CreateAmlAlertRequest with details
=======
https://api.achilles.tokend.io /v3/fees
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "value" : 1 ,
"name" : "General"
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/fees?include=asset&page[number]=2&page[limit]=15" ,
"self" : "/v3/fees?include=asset&page[number]=1&page[limit]=15"
} }
Defines access points to AMLAlert Reviewable Requests
AMLAlert by ID Allows getting CreateAmlAlert by ID
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.balance]string
Filters create aml alert requests by balance.
includestring
Enum: "request_details" "request_details.balance"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
get /v3/create_aml_alert_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_aml_alert_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
AMLAlert List Allows getting a filtered list of CreateAmlAlertRequest with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.balance]string
Filters create aml alert requests by balance.
includestring
Enum: "request_details" "request_details.balance"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 requests do not exist
get /v3/create_aml_alert_requests TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/create_aml_alert_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "amount" : "1000.123456" ,
"creator_details" : { }
} } ] , "links" :
{ "next" : "/v3/create_aml_alert_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_aml_alert_requests?include=details&page[number]=1&page[limit]=15"
} }
AMLAlert by ID Allows getting CreateAmlAlert by ID
=======
https://api.achilles.tokend.io /v3/create_aml_alert_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/create_aml_alert_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_aml_alert_requests?include=details&page[number]=1&page[limit]=15"
} }
Defines access points to get Issuance Reviewable Requests
Issuance Request by ID Allows getting CreateIssuance by ID
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.balance]string
Filters create aml alert requests by balance.
includestring
Enum: "request_details" "request_details.balance"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
<<<<<<< HEAD
get /v3/create_aml_alert_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_aml_alert_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "amount" : "1000.123456" ,
"creator_details" : { }
} } ] }
Defines access points to get Issuance Reviewable Requests
Issuance Request List Allows getting a filtered list of CreateIssuanceRequest with details
=======
get /v3/create_issuance_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_issuance_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
Issuance Request List Allows getting a filtered list of CreateIssuanceRequest with details
>>>>>>> master
🔒 Requestor's, reviewer's or receiving balance owner signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.asset]string
Filters issuance create requests by asset code.
filter[request_details.receiver]string
Filters requests by receiver balance
includestring
Enum: "request_details" "request_details.asset"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 requests do not exist
get /v3/create_issuance_requests TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/create_issuance_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , } , "attributes" :
{ "amount" : "1000.123456" ,
"creator_details" : { }
} } ] , "links" :
{ "next" : "/v3/issuance_create_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/issuance_create_requests?include=details&page[number]=1&page[limit]=15"
} }
Issuance Request by ID Allows getting CreateIssuance by ID
=======
https://api.achilles.tokend.io /v3/create_issuance_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/issuance_create_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/issuance_create_requests?include=details&page[number]=1&page[limit]=15"
} }
Defines access points to get Withdrawal Reviewable Requests
Withdrawal Request by ID Allows getting CreateWithdraw by ID
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.asset]string
Filters preissuance create requests by asset code.
includestring
Enum: "request_details" "request_details.asset"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
<<<<<<< HEAD
get /v3/create_issuance_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_issuance_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , } , "attributes" :
{ "amount" : "1000.123456" ,
"creator_details" : { }
} } ] }
Defines access points to get Withdrawal Reviewable Requests
Withdrawal Request List Allows getting a filtered list of CreateWithdrawRequest with details
=======
get /v3/create_withdraw_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_withdraw_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
Withdrawal Request List Allows getting a filtered list of CreateWithdrawRequest with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.balance]string
Filters create_withdraw requests by balance.
filter[request_details.asset]string
Filters create withdraw requests by asset.
includestring
Enum: "request_details" "request_details.balance" "request_details.asset"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 requests do not exist
get /v3/create_withdraw_requests TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/create_withdraw_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } , "attributes" :
{ "amount" : "1000.123456" ,
"creator_details" : { }
} } ] , "links" :
{ "next" : "/v3/create_withdraw_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_withdraw_requests?include=details&page[number]=1&page[limit]=15"
} }
Withdrawal Request by ID Allows getting CreateWithdraw by ID
=======
https://api.achilles.tokend.io /v3/create_withdraw_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/create_withdraw_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_withdraw_requests?include=details&page[number]=1&page[limit]=15"
} }
Atomic Swap Ask by ID Allows getting Atomic Swap Ask with corresponding details.
path Parameters id required
string
Unique identifier of an atomic swap ask (id)
query Parameters includestring
Enum: "base_balance" "owner" "base_asset" "quote_assets"
Relationships that may be used for the included parameter.
Responses 200 atomic swap ask exists
get /v3/atomic_swap_asks/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/atomic_swap_asks/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
Atomic Swap Ask List Allows getting a filtered list of Atomic Swap Ask with corresponding details.
query Parameters filter[base_asset]integer
Filters atomic swap asks by a base asset.
filter[owner]string
Filters atomic swap asks by a specified owner's account address.
filter[quote_assets]Array of string
Filters atomic swap asks by quote assets. Returns the page of atomic swap asks where all quote assets present.
includestring
Enum: "base_balance" "owner" "base_asset" "quote_assets"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 200 atomic swap ask exists
TokenD Developer Environment
https://api.achilles.tokend.io /v3/atomic_swap_asks
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "links" :
{ "next" : "/v3/assets?include=owner&page[number]=2&page[limit]=15" ,
"self" : "/v3/assets?include=owner&page[number]=1&page[limit]=15"
} }
Create Atomic Swap Ask Request by ID Allows getting CreateAtomicSwapAsk by ID
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.balance]string
Filters create_withdraw requests by balance.
filter[request_details.asset]string
Filters create withdraw requests by asset.
includestring
Enum: "request_details" "request_details.balance" "request_details.asset"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
<<<<<<< HEAD
get /v3/create_withdraw_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_withdraw_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } , "attributes" :
{ "amount" : "1000.123456" ,
"creator_details" : { }
} } ] }
Atomic Swap Ask List Allows getting a filtered list of Atomic Swap Ask with corresponding details.
query Parameters filter[base_asset]integer
Filters atomic swap asks by a base asset.
filter[owner]string
Filters atomic swap asks by a specified owner's account address.
filter[quote_assets]Array of string
Filters atomic swap asks by quote assets. Returns the page of atomic swap asks where all quote assets present.
includestring
Enum: "base_balance" "owner" "base_asset" "quote_assets"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 200 atomic swap ask exists
TokenD Developer Environment
https://api.achilles.tokend.io /v3/atomic_swap_asks
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "links" :
{ "next" : "/v3/assets?include=owner&page[number]=2&page[limit]=15" ,
"self" : "/v3/assets?include=owner&page[number]=1&page[limit]=15"
} }
Atomic Swap Ask by ID Allows getting Atomic Swap Ask with corresponding details.
path Parameters id required
string
Unique identifier of an atomic swap ask (id)
query Parameters includestring
Enum: "base_balance" "owner" "base_asset" "quote_assets"
Relationships that may be used for the included parameter.
Responses 200 atomic swap ask exists
get /v3/atomic_swap_asks/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/atomic_swap_asks/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
Create Atomic Swap Ask Request List Allows getting a filtered list of CreateAtomicSwapAskRequest with details
=======
get /v3/create_atomic_swap_ask_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_atomic_swap_ask_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
Create Atomic Swap Ask Request List Allows getting a filtered list of CreateAtomicSwapAskRequest with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.base_balance]string
Filters create_atomic_swap_ask requests by balance.
includestring
Enum: "request_details" "request_details.base_balance" "request_details.quote_assets"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 requests do not exist
get /v3/create_atomic_swap_ask_requests TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/create_atomic_swap_ask_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "quote_assets" :
{ "data" :
[
{ "id" : "USD" ,
"type" : "assets"
} ] } } , } ] , "links" :
{ "next" : "/v3/create_atomic_swap_bid_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_atomic_swap_bid_requests?include=details&page[number]=1&page[limit]=15"
} }
Create Atomic Swap Ask Request by ID Allows getting CreateAtomicSwapAsk by ID
=======
https://api.achilles.tokend.io /v3/create_atomic_swap_ask_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/create_atomic_swap_bid_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_atomic_swap_bid_requests?include=details&page[number]=1&page[limit]=15"
} }
Create Atomic Swap Bid Request by ID Allows getting CreateAtomicSwapBid by ID
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.base_balance]string
Filters create_atomic_swap_ask requests by base balance.
includestring
Enum: "request_details" "request_details.base_balance" "request_details.quote_assets"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
<<<<<<< HEAD
get /v3/create_atomic_swap_ask_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_atomic_swap_ask_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "quote_assets" :
{ "data" :
[
{ "id" : "USD" ,
"type" : "assets"
} ] } } , } ] }
Create Atomic Swap Bid Request List Allows getting a filtered list of CreateAtomicSwapBidRequest with details
=======
get /v3/create_atomic_swap_bid_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_atomic_swap_bid_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
Create Atomic Swap Bid Request List Allows getting a filtered list of CreateAtomicSwapBidRequest with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.quote_asset]string
Filters atomic swap bid requests by quote asset.
filter[request_details.ask_id]integer
Filters atomic swap bid requests by atomic swap ask id.
filter[request_details.ask_owner]integer
Filters atomic swap bid requests by atomic swap ask owner id.
includestring
Enum: "request_details" "request_details.quote_asset"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 requests do not exist
get /v3/create_atomic_swap_bid_requests TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/create_atomic_swap_bid_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "ask" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } , "quote_asset" :
{ "data" :
{ "id" : "5" ,
"type" : "quote-assets"
} } } , } ] , "links" :
{ "next" : "/v3/create_atomic_swap_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_atomic_swap_requests?include=details&page[number]=1&page[limit]=15"
} }
Create Atomic Swap Bid Request by ID Allows getting CreateAtomicSwapBid by ID
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
=======
https://api.achilles.tokend.io /v3/create_atomic_swap_bid_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/create_atomic_swap_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_atomic_swap_requests?include=details&page[number]=1&page[limit]=15"
} }
Swap by ID Allows getting Swap with corresponding details.
🔒 Admin, swap source, or swap destination signature is required
path Parameters id required
integer <int64>
Example: 10
Unique identifier of a swap
query Parameters includestring
Enum: "source_balance" "destination_balance" "asset"
Relationships that may be used for the included parameter.
filter[source]string
Filters swaps by a specified source's account address.
filter[destination]string
Filters swaps by a specified destination's account address.
filter[destination_balance]string
Filters swaps by a specified destination's balance address.
filter[source_balance]string
Filters swaps by a specified source's balance address.
filter[state]integer
Example: 1
Filters sales by a specified sale state.
Available sale states:
>>>>>>> master
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.quote_asset]string
Filters create_atomic_swap_bid requests by quote asset.
includestring
Enum: "request_details" "request_details.quote_asset"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
get /v3/create_atomic_swap_bid_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_atomic_swap_bid_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "ask" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } , "quote_asset" :
{ "data" :
{ "id" : "5" ,
"type" : "quote-assets"
} } } , } ] }
Swaps list Allows getting a filtered list of Swaps with corresponding details.
🔒 Depending on the case, different signatures are required:
if no filters are applied, admin signature is required.
if filter by source is applied, signature of source is required
if filter by destination is applied, signature of destination is required
query Parameters includestring
Enum: "source_balance" "destination_balance" "asset"
Relationships that may be used for the included parameter.
filter[source]string
Filters swaps by a specified source's account address.
filter[destination]string
Filters swaps by a specified destination's account address.
filter[destination_balance]string
Filters swaps by a specified destination's balance address.
filter[source_balance]string
Filters swaps by a specified source's balance address.
filter[state]integer
Example: 1
Filters sales by a specified sale state.
Available sale states:
1 - open
2 - closed
3 - cancelled
page[cursor]integer >= 0
Cursor point to the end of the previous page
page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
TokenD Developer Environment
https://api.achilles.tokend.io /v3/swaps
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "5" ,
"type" : "swaps" ,
"attributes" :
{ "created_at" : "2012-11-01T22:08:41+00:00" ,
"lock_time" : "2012-11-01T22:08:41+00:00" ,
"state" : 2 ,
"secret_hash" : "string" ,
"amount" : "123.123456" ,
"details" : { } ,
"secret" : "string"
} , "relationships" :
{ "destination_balance" :
{ } , "asset" :
{ "id" : "USD" ,
"type" : "assets"
} } } ] , "included" : [ ] ,
}
Swap by ID Allows getting Swap with corresponding details.
🔒 Admin, swap source, or swap destination signature is required
path Parameters id required
integer <int64>
Example: 10
Unique identifier of a swap
query Parameters includestring
Enum: "source_balance" "destination_balance" "asset"
Relationships that may be used for the included parameter.
filter[source]string
Filters swaps by a specified source's account address.
filter[destination]string
Filters swaps by a specified destination's account address.
filter[destination_balance]string
Filters swaps by a specified destination's balance address.
filter[source_balance]string
Filters swaps by a specified source's balance address.
filter[state]integer
Example: 1
Filters sales by a specified sale state.
Available sale states:
1 - open
2 - closed
3 - cancelled
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
TokenD Developer Environment
https://api.achilles.tokend.io /v3/swaps/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "5" ,
"type" : "swaps" ,
"attributes" :
{ "created_at" : "2012-11-01T22:08:41+00:00" ,
"lock_time" : "2012-11-01T22:08:41+00:00" ,
"state" : 2 ,
"secret_hash" : "string" ,
"amount" : "123.123456" ,
"details" : { } ,
"secret" : "string"
} , "relationships" :
{ "destination_balance" :
{ } , "asset" :
{ "id" : "USD" ,
"type" : "assets"
} } } , "included" : [ ]
}
Defines access points to get signers
Signers for Account Allows getting Signers of the account with corresponding details.
path Parameters id required
string
Unique identifier of an account
query Parameters includestring
Enum: "role" "role.rules"
Example: "role,role.rules"
For signers, following relationships can be included:
Responses 404 such an account does not exist
get /v3/accounts/{id}/signers TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/accounts/{id}/signers
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "links" :
{ "next" : "/v3/accounts/GA67BUDBYDGCVCL6EKPDAREG5IPLHSROF6QJX7MLS2BQJZJDO6FCZAKE/signers?include=role,role.rules&page[number]=2&page[limit]=15" ,
"self" : "/v3/accounts/GA67BUDBYDGCVCL6EKPDAREG5IPLHSROF6QJX7MLS2BQJZJDO6FCZAKE/signers?include=role,role.rules&page[number]=1&page[limit]=15"
} }
Signer Role List Allows getting a list of Signer Role with corresponding details.
query Parameters includestring
Value: "rules"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 200 succesfully retrieved page
TokenD Developer Environment
https://api.achilles.tokend.io /v3/signer_roles
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "4581" ,
"type" : "signer-roles" ,
"relationships" :
{ "rules" :
{ "data" :
[
{ "id" : "7582" ,
"type" : "signer-rules"
} ] } , } , } ] , "included" :
[
{ "id" : "7582" ,
"type" : "signer-rules" ,
"attributes" :
{ "action" : 0 ,
"forbids" : false ,
"details" : { } ,
"resource" : { } ,
"is_default" : true
} } ] , "links" :
{ "next" : "/v3/signer_roles?include=rules&page[number]=2&page[limit]=15" ,
"self" : "/v3/signer_roles?include=rules&page[number]=1&page[limit]=15"
} }
Signer Role by ID Allows getting Signer Role with corresponding details.
=======
https://api.achilles.tokend.io /v3/accounts/{id}/signers
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "links" :
{ "next" : "/v3/accounts/GA67BUDBYDGCVCL6EKPDAREG5IPLHSROF6QJX7MLS2BQJZJDO6FCZAKE/signers?include=role,role.rules&page[number]=2&page[limit]=15" ,
"self" : "/v3/accounts/GA67BUDBYDGCVCL6EKPDAREG5IPLHSROF6QJX7MLS2BQJZJDO6FCZAKE/signers?include=role,role.rules&page[number]=1&page[limit]=15"
} }
Signer Role by ID Allows getting Signer Role with corresponding details.
>>>>>>> master
path Parameters id required
string
Unique identifier of the signer role
query Parameters includestring
Value: "rules"
Relationships that may be used for the included parameter.
Responses 404 signer role does not exist
get /v3/signer_roles/{id} TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/signer_roles/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "4581" ,
"type" : "signer-roles" ,
"relationships" :
{ "rules" :
{ "data" :
[
{ "id" : "7582" ,
"type" : "signer-rules"
} ] } , } , } , "included" :
[
{ "id" : "7582" ,
"type" : "signer-rules" ,
"attributes" :
{ "action" : 0 ,
"forbids" : false ,
"details" : { } ,
"resource" : { } ,
"is_default" : true
} } ] }
Signer Rule List Allows getting a list of Signer Rule with corresponding details.
query Parameters page[number]integer >= 0
Page number to return.
=======
https://api.achilles.tokend.io /v3/signer_roles/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "4581" ,
"type" : "signer-roles" ,
"relationships" :
{ "rules" :
{ "data" :
[
{ "id" : "7582" ,
"type" : "signer-rules"
} ] } , } , } , "included" :
[
{ "id" : "7582" ,
"type" : "signer-rules" ,
"attributes" :
{ "action" :
{ "value" : 1 ,
"name" : "General"
} , "forbids" : false ,
"details" : { } ,
"resource" : { } ,
"is_default" : true
} } ] }
Signer Role List Allows getting a list of Signer Role with corresponding details.
query Parameters includestring
Value: "rules"
Relationships that may be used for the included parameter.
page[number]integer >= 0
Page number to return.
>>>>>>> master
page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 200 succesfully retrieved page
400 bad input parameter
<<<<<<< HEAD
TokenD Developer Environment
https://api.achilles.tokend.io /v3/signer_rules
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "7582" ,
"type" : "signer-rules" ,
"attributes" :
{ "action" : 0 ,
"forbids" : false ,
"details" : { } ,
"resource" : { } ,
"is_default" : true
} } ] , "links" :
{ "next" : "/v3/signer_rules?page[number]=2&page[limit]=15" ,
"self" : "/v3/signer_rules?page[number]=1&page[limit]=15"
} }
Signer Rule by ID Allows getting Signer Rule with corresponding details.
=======
TokenD Developer Environment
https://api.achilles.tokend.io /v3/signer_roles
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "4581" ,
"type" : "signer-roles" ,
"relationships" :
{ "rules" :
{ "data" :
[
{ "id" : "7582" ,
"type" : "signer-rules"
} ] } , } , } ] , "included" :
[
{ "id" : "7582" ,
"type" : "signer-rules" ,
"attributes" :
{ "action" :
{ "value" : 1 ,
"name" : "General"
} , "forbids" : false ,
"details" : { } ,
"resource" : { } ,
"is_default" : true
} } ] , "links" :
{ "next" : "/v3/signer_roles?include=rules&page[number]=2&page[limit]=15" ,
"self" : "/v3/signer_roles?include=rules&page[number]=1&page[limit]=15"
} }
Signer Rule by ID Allows getting Signer Rule with corresponding details.
>>>>>>> master
path Parameters id required
string
Unique identifier of the signer rule
Responses 404 signer rule does not exist
get /v3/signer_rules/{id} TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/signer_rules/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "7582" ,
"type" : "signer-rules" ,
"attributes" :
{ "action" : 0 ,
"forbids" : false ,
"details" : { } ,
"resource" : { } ,
"is_default" : true
} } }
Defines access points to get account role
Account Role List Allows getting a list of Account Role with corresponding details.
query Parameters includestring
Value: "rules"
Relationships that may be used for the included parameter.
page[number]integer >= 0
Page number to return.
=======
https://api.achilles.tokend.io /v3/signer_rules/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "7582" ,
"type" : "signer-rules" ,
"attributes" :
{ "action" :
{ "value" : 1 ,
"name" : "General"
} , "forbids" : false ,
"details" : { } ,
"resource" : { } ,
"is_default" : true
} } }
Signer Rule List Allows getting a list of Signer Rule with corresponding details.
query Parameters page[number]integer >= 0
Page number to return.
>>>>>>> master
page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 200 succesfully retrieved page
400 bad input parameter
<<<<<<< HEAD
TokenD Developer Environment
https://api.achilles.tokend.io /v3/account_roles
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "4581" ,
"type" : "account-roles" ,
"relationships" :
{ "rules" :
{ "data" :
[
{ "id" : "7582" ,
"type" : "account-rules"
} ] } } , } ] , "included" :
[
{ "id" : "7582" ,
"type" : "account-rules" ,
"attributes" :
{ "action" : 0 ,
"forbids" : false ,
"details" : { } ,
"resource" : { }
} } ] }
Account Role by ID Allows getting Account Role with corresponding details.
=======
TokenD Developer Environment
https://api.achilles.tokend.io /v3/signer_rules
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "7582" ,
"type" : "signer-rules" ,
"attributes" :
{ "action" :
{ "value" : 1 ,
"name" : "General"
} , "forbids" : false ,
"details" : { } ,
"resource" : { } ,
"is_default" : true
} } ] , "links" :
{ "next" : "/v3/signer_rules?page[number]=2&page[limit]=15" ,
"self" : "/v3/signer_rules?page[number]=1&page[limit]=15"
} }
Defines access points to get account role
Account Role by ID Allows getting Account Role with corresponding details.
>>>>>>> master
path Parameters id required
string
Unique identifier of an account role
query Parameters includestring
Value: "rules"
Relationships that may be used for the included parameter.
Responses 404 account role does not exist
get /v3/account_roles/{id} TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/account_roles/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "4581" ,
"type" : "account-roles" ,
"relationships" :
{ "rules" :
{ "data" :
[
{ "id" : "7582" ,
"type" : "account-rules"
} ] } } , } , "included" :
[
{ "id" : "7582" ,
"type" : "account-rules" ,
"attributes" :
{ "action" : 0 ,
"forbids" : false ,
"details" : { } ,
"resource" : { }
} } ] }
Account Rule List Allows getting a list of Account Rule with corresponding details.
query Parameters page[number]integer >= 0
Page number to return.
=======
https://api.achilles.tokend.io /v3/account_roles/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "4581" ,
"type" : "account-roles" ,
"relationships" :
{ "rules" :
{ "data" :
[
{ "id" : "7582" ,
"type" : "account-rules"
} ] } } , } , "included" :
[
{ "id" : "7582" ,
"type" : "account-rules" ,
"attributes" :
{ "action" :
{ "value" : 1 ,
"name" : "General"
} , "forbids" : false ,
"details" : { } ,
"resource" : { }
} } ] }
Account Role List Allows getting a list of Account Role with corresponding details.
query Parameters includestring
Value: "rules"
Relationships that may be used for the included parameter.
page[number]integer >= 0
Page number to return.
>>>>>>> master
page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 200 succesfully retrieved page
400 bad input parameter
<<<<<<< HEAD
TokenD Developer Environment
https://api.achilles.tokend.io /v3/account_rules
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "7582" ,
"type" : "account-rules" ,
"attributes" :
{ "action" : 0 ,
"forbids" : false ,
"details" : { } ,
"resource" : { }
} } ] , "links" :
{ "next" : "/v3/account_rules?page[number]=2&page[limit]=15" ,
"self" : "/v3/account_rules?page[number]=1&page[limit]=15"
} }
Account Rule by ID Allows getting Account Rule with corresponding details.
=======
TokenD Developer Environment
https://api.achilles.tokend.io /v3/account_roles
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "4581" ,
"type" : "account-roles" ,
"relationships" :
{ "rules" :
{ "data" :
[
{ "id" : "7582" ,
"type" : "account-rules"
} ] } } , } ] , "included" :
[
{ "id" : "7582" ,
"type" : "account-rules" ,
"attributes" :
{ "action" :
{ "value" : 1 ,
"name" : "General"
} , "forbids" : false ,
"details" : { } ,
"resource" : { }
} } ] }
Account Rule by ID Allows getting Account Rule with corresponding details.
>>>>>>> master
path Parameters id required
string
Unique identifier of an account rule
Responses 404 account rule does not exist
get /v3/account_rules/{id} TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/account_rules/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "7582" ,
"type" : "account-rules" ,
"attributes" :
{ "action" : 0 ,
"forbids" : false ,
"details" : { } ,
"resource" : { }
} } }
Change Account Role Request Change Account Role Request List Allows getting a filtered list of ChangeRoleRequest with details
=======
https://api.achilles.tokend.io /v3/account_rules/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "7582" ,
"type" : "account-rules" ,
"attributes" :
{ "action" :
{ "value" : 1 ,
"name" : "General"
} , "forbids" : false ,
"details" : { } ,
"resource" : { }
} } }
Account Rule List Allows getting a list of Account Rule with corresponding details.
query Parameters page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 200 succesfully retrieved page
TokenD Developer Environment
https://api.achilles.tokend.io /v3/account_rules
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "7582" ,
"type" : "account-rules" ,
"attributes" :
{ "action" :
{ "value" : 1 ,
"name" : "General"
} , "forbids" : false ,
"details" : { } ,
"resource" : { }
} } ] , "links" :
{ "next" : "/v3/account_rules?page[number]=2&page[limit]=15" ,
"self" : "/v3/account_rules?page[number]=1&page[limit]=15"
} }
Change Account Role Request Change Account Role Request by ID Allows to get ChangeRole by ID
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by the requestor - source of the operation.
filter[reviewer]string
Filters requests by the reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.destination_account]string
Filters change role requests by destination account.
filter[request_details.account_role_to_set]string
Filters change role requests by account_role_to_set.
includestring
Enum: "request_details" "request_details.account"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
get /v3/change_role_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/change_role_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
Change Account Role Request List Allows getting a filtered list of ChangeRoleRequest with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.destination_account]string
Filters change_role requests by account to change role.
filter[request_details.account_role_to_set]string
Filters change_role requests by account_role_to_set.
includestring
Enum: "request_details" "request_details.account"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 requests do not exist
get /v3/change_role_requests TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/change_role_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "account_to_update_role" :
{ } } , } ] , "links" :
{ "next" : "/v3/change_role_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/change_role_requests?include=details&page[number]=1&page[limit]=15"
} }
Change Account Role Request by ID Allows to get ChangeRole by ID
=======
https://api.achilles.tokend.io /v3/change_role_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/change_role_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/change_role_requests?include=details&page[number]=1&page[limit]=15"
} }
Defines access points to AMLAlert Reviewable Requests
AMLAlert by ID Allows getting CreateAmlAlert by ID
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by the requestor - source of the operation.
filter[reviewer]string
Filters requests by the reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.destination_account]string
Filters change role requests by destination account.
filter[request_details.account_role_to_set]string
Filters change role requests by account_role_to_set.
includestring
Enum: "request_details" "request_details.account"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
<<<<<<< HEAD
get /v3/change_role_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/change_role_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "account_to_update_role" :
{ } } , } ] }
Defines access points to AMLAlert Reviewable Requests
AMLAlert List Allows getting a filtered list of CreateAmlAlertRequest with details
=======
get /v3/create_aml_alert_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_aml_alert_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
AMLAlert List Allows getting a filtered list of CreateAmlAlertRequest with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.balance]string
Filters create aml alert requests by balance.
includestring
Enum: "request_details" "request_details.balance"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 requests do not exist
get /v3/create_aml_alert_requests TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/create_aml_alert_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "amount" : "1000.123456" ,
"creator_details" : { }
} } ] , "links" :
{ "next" : "/v3/create_aml_alert_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_aml_alert_requests?include=details&page[number]=1&page[limit]=15"
} }
AMLAlert by ID Allows getting CreateAmlAlert by ID
=======
https://api.achilles.tokend.io /v3/create_aml_alert_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/create_aml_alert_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_aml_alert_requests?include=details&page[number]=1&page[limit]=15"
} }
Limits List Allows getting a filtered list of Limits with corresponding details.
query Parameters filter[asset] filter[stats_op_type]integer
Filters limits by statsOpType.
filter[account]string
Filters limits by account address.
filter[account_role]integer
Filters limits by account role.
includestring
Value: "asset"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
TokenD Developer Environment
https://api.achilles.tokend.io /v3/limits
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "1" ,
"type" : "limits" ,
"relationships" :
{ "asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , } , "attributes" :
{ "stats_op_type" : 1 ,
"is_convert_needed" : true ,
"daily_out" : "100.000000" ,
"weekly_out" : "700.000000" ,
"monthly_out" : "3000.000000" ,
"annual_out" : "36500.000000"
} } ] , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "value" : 1 ,
"name" : "General"
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/limits?include=asset&page[number]=2&page[limit]=15" ,
"self" : "/v3/limits?include=asset&page[number]=1&page[limit]=15"
} }
Update Limits Request by ID Allows getting UpdateLimits by ID
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.balance]string
Filters create aml alert requests by balance.
includestring
Enum: "request_details" "request_details.balance"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
<<<<<<< HEAD
get /v3/create_aml_alert_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_aml_alert_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "amount" : "1000.123456" ,
"creator_details" : { }
} } ] }
Limits List Allows getting a filtered list of Limits with corresponding details.
query Parameters filter[asset] filter[stats_op_type]integer
Filters limits by statsOpType.
filter[account]string
Filters limits by account address.
filter[account_role]integer
Filters limits by account role.
includestring
Value: "asset"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
TokenD Developer Environment
https://api.achilles.tokend.io /v3/limits
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "1" ,
"type" : "limits" ,
"relationships" :
{ "asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , } , "attributes" :
{ "stats_op_type" : 1 ,
"is_convert_needed" : true ,
"daily_out" : "100.000000" ,
"weekly_out" : "700.000000" ,
"monthly_out" : "3000.000000" ,
"annual_out" : "36500.000000"
} } ] , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "name" : "string" ,
"value" : 2
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/limits?include=asset&page[number]=2&page[limit]=15" ,
"self" : "/v3/limits?include=asset&page[number]=1&page[limit]=15"
} }
Update Limits Request List Allows getting a filtered list of UpdateLimitsRequest with details
=======
get /v3/update_limits_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/update_limits_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
Update Limits Request List Allows getting a filtered list of UpdateLimitsRequest with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review request.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
includestring
Value: "request_details"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 requests do not exist
get /v3/update_limits_requests TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/update_limits_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
} ] , "links" :
{ "next" : "/v3/update_limits_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/update_limits_requests?include=details&page[number]=1&page[limit]=15"
} }
Update Limits Request by ID Allows getting UpdateLimits by ID
=======
https://api.achilles.tokend.io /v3/update_limits_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/update_limits_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/update_limits_requests?include=details&page[number]=1&page[limit]=15"
} }
KYC Recovery Request By ID Allows to get KYCRecovery by ID
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
includestring
Value: "request_details"
Relationships that may be used for the included parameter.
Responses 404 request does not exist
<<<<<<< HEAD
get /v3/update_limits_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/update_limits_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
} ] }
KYC Recovery Request List Allows getting a filtered list of KYCRecoveryRequest with details
=======
get /v3/kyc_recovery_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/kyc_recovery_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
KYC Recovery Request List Allows getting a filtered list of KYCRecoveryRequest with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.target_account]string
Filters kyc recovery requests by target account
includestring
Enum: "request_details" "request_details.target_account"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 requests do not exist
get /v3/kyc_recovery_requests TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/kyc_recovery_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "sequence_number" : 4 ,
"signers_data" :
[
{ "identity" : 0 ,
"role_id" : 1 ,
"weight" : 12 ,
"details" : { }
} ] , "creator_details" : { }
} } ] , "links" :
{ "next" : "/v3/kyc_recovery_requests?include=request_details&page[number]=2&page[limit]=15" ,
"self" : "/v3/kyc_recovery_requests?include=request_details&page[number]=1&page[limit]=15"
} }
KYC Recovery Request By ID Allows to get KYCRecovery by ID
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by the requestor - source of the operation.
filter[reviewer]string
Filters requests by the reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.target_account]string
Filters change role requests by destination account.
includestring
Enum: "request_details" "request_details.target_account"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
get /v3/kyc_recovery_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/kyc_recovery_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "sequence_number" : 4 ,
"signers_data" :
[
{ "identity" : 0 ,
"role_id" : 1 ,
"weight" : 12 ,
"details" : { }
} ] , "creator_details" : { }
} } ] }
https://api.achilles.tokend.io /v3/kyc_recovery_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/kyc_recovery_requests?include=request_details&page[number]=2&page[limit]=15" ,
"self" : "/v3/kyc_recovery_requests?include=request_details&page[number]=1&page[limit]=15"
} }
>>>>>>> master
A base asset refers to the underlying assets giving value to a company, investment or loan.
Base asset is not fixed. It will appreciate or depreciate according to market forces.
A quote asset refers to the last amount at which 1 base asset was traded,
meaning the most recent price to which a buyer and seller have agreed as well as the price
at which some 1 base asset was transacted
<<<<<<< HEAD
AssetPair List Allows getting a filtered list of AssetPair with corresponding details.
=======
AssetPair by ID Allows getting AssetPair with corresponding details.
path Parameters id required
string <BASE:QUOTE>
Example: "BTC:ETH"
Unique identifier of an asset pair that consists of two asset codes
query Parameters includestring
Enum: "base_asset" "quote_asset"
Example: "base_asset"
Relationships that may be used for the include parameter.
Responses 404 asset pair does not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/asset_pairs/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "BTC:ETH" ,
"type" : "asset-pairs" ,
"relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } , } , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "value" : 1 ,
"name" : "General"
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] }
AssetPair List Allows getting a filtered list of AssetPair with corresponding details.
>>>>>>> master
query Parameters filter[policy]integer <int32>
Example: 2
Filters asset pairs by a specified bit mask. Returns the page of asset pairs where at least one bit intersects.
filter[base_asset]string <valid AssetCode>
Example: "BTC"
Filters asset pairs by a specified base asset of the pair.
filter[quote_asset]string <valid AssetCode>
Example: "ETH"
Filters asset pairs by a specified quote asset of the pair.
filter[asset]string <valid AssetCode>
Example: "ETH"
Filters asset pairs by a specified asset of the pair (no matter whether it is a base or quote asset)
includestring
Enum: "base_asset" "quote_asset"
Example: "base_asset,quote_asset"
Relationships that may be used for the include parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 200 asset pairs that satisfy specified filters
404 asset pair does not exist
TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/asset_pairs
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "BTC:ETH" ,
"type" : "asset-pairs" ,
"relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } , } ] , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "name" : "string" ,
"value" : 2
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/assets_pairs?include=base_asset&page[number]=2&page[limit]=15" ,
"self" : "/v3/assets_pairs?include=base_asset&page[number]=1&page[limit]=15"
} }
AssetPair by ID Allows getting AssetPair with corresponding details.
path Parameters id required
string <BASE:QUOTE>
Example: "BTC:ETH"
Unique identifier of an asset pair that consists of two asset codes
query Parameters includestring
Enum: "base_asset" "quote_asset"
Example: "base_asset"
Relationships that may be used for the include parameter.
Responses 404 asset pair does not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/asset_pairs/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "BTC:ETH" ,
"type" : "asset-pairs" ,
"relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } , } , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "name" : "string" ,
"value" : 2
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] }
Offers List Allows getting a filtered list of Offer with corresponding details.
=======
https://api.achilles.tokend.io /v3/asset_pairs
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "BTC:ETH" ,
"type" : "asset-pairs" ,
"relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } , } ] , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "value" : 1 ,
"name" : "General"
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/assets_pairs?include=base_asset&page[number]=2&page[limit]=15" ,
"self" : "/v3/assets_pairs?include=base_asset&page[number]=1&page[limit]=15"
} }
Offer by ID Allows getting Offer with corresponding details.
🔒 An owner's or admin's signature is needed to get the data from this endpoint.
path Parameters id required
integer <int64>
Example: 10
Unique identifier of an offer
query Parameters includestring
Enum: "base_asset" "quote_asset"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
TokenD Developer Environment
https://api.achilles.tokend.io /v3/offers/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "10" ,
"type" : "offers" ,
"attributes" :
{ "is_buy" : true ,
"order_book_id" : "1" ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"base_amount" : "5.000000" ,
"quote_amount" : "15.000000" ,
"price" : "3.000000" ,
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , } } , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "value" : 1 ,
"name" : "General"
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] }
Offers List Allows getting a filtered list of Offer with corresponding details.
>>>>>>> master
🔒 Depending on the case, different signatures are required:
if no filters are applied, admin account's signature is required.
if filters are applied, signature of the account by which the filter was requested is required
query Parameters filter[base_balance]string <valid balanceID>
Example: "BDLXKLLVS6UIQEDYCZKIC5222GGQLCOTHM4BWXVCBDQMJTUWUFUATV2Q"
Filters offers by specified base balance ID
filter[quote_balance]string <valid balanceID>
Example: "BPGIKLLVS6UIQEDYCJRFH53GJ7GQLCOTHM4BWXVCBDQMJTUWUDPQTVLO"
Filters offers by specified quote balance ID
filter[base_asset]string <valid assetCode>
Example: "BTC"
Filters offers by specified base asset code
filter[quote_asset]string <valid assetCode>
Example: "ETH"
Filters offers by specified quote asset code
filter[owner]string <valid accountID>
Example: "GAULFBQKQTFHHHZEIRMYVCGTY47FKWEW7P2BY2YT45HAEODAIJUJH23T"
Filters offers by a specified account that created the offer
filter[order_book]number <int64>
Example: 2
Filters offers by specified order book ID
Defines whether offers are for sale or for trade
(0 - secondary market, saleId - for specific sale)
filter[is_buy]number <int32>
Example: 1
Defines whether an offer is on buying or selling the base_asset, or both
if is_buy == true -> only buy base_asset offers are filtered
if is_buy == false -> only sell base_asset offers are filtered
if is_buy is not specified -> both buy and sell base_asset offers are filtered
includestring
Enum: "base_asset" "quote_asset"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/offers
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "10" ,
"type" : "offers" ,
"attributes" :
{ "is_buy" : true ,
"order_book_id" : "1" ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"base_amount" : "5.000000" ,
"quote_amount" : "15.000000" ,
"price" : "3.000000" ,
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , } } ] , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "name" : "string" ,
"value" : 2
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/offers?include=base_asset&page[number]=2&page[limit]=15" ,
"self" : "/v3/offers?include=base_asset&page[number]=1&page[limit]=15"
} }
Offer by ID Allows getting Offer with corresponding details.
🔒 An owner's or admin's signature is needed to get the data from this endpoint.
path Parameters id required
integer <int64>
Example: 10
Unique identifier of an offer
query Parameters includestring
Enum: "base_asset" "quote_asset"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
TokenD Developer Environment
https://api.achilles.tokend.io /v3/offers/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "10" ,
"type" : "offers" ,
"attributes" :
{ "is_buy" : true ,
"order_book_id" : "1" ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"base_amount" : "5.000000" ,
"quote_amount" : "15.000000" ,
"price" : "3.000000" ,
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , } } , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "name" : "string" ,
"value" : 2
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] }
An order book is a list of buy and sell orders for a specified asset pair organized by price level.
=======
https://api.achilles.tokend.io /v3/offers
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "10" ,
"type" : "offers" ,
"attributes" :
{ "is_buy" : true ,
"order_book_id" : "1" ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"base_amount" : "5.000000" ,
"quote_amount" : "15.000000" ,
"price" : "3.000000" ,
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , } } ] , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "value" : 1 ,
"name" : "General"
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/offers?include=base_asset&page[number]=2&page[limit]=15" ,
"self" : "/v3/offers?include=base_asset&page[number]=1&page[limit]=15"
} }
An order book is a list of buy and sell orders for a specified asset pair organized by price level.
>>>>>>> master
An order book lists the amount of asset being bid or offered at each price point.
It does not identify market participants behind buy and sell orders.
OrderBook by ID Deprecated Returns the list of placed offers without private details.
path Parameters id required
integer <int64>
ID of an order book: 0 for the secondary market and sale ID otherwise
query Parameters base_assetstring <valid assetCode>
Example: "BTC"
Base asset of requested offers
quote_assetstring <valid assetCode>
Example: "ETH"
Quote asset of requested offers
is_buynumber
Defines whether an offer is on buying or selling the base_asset
includestring
Enum: "base_asset" "quote_asset"
Relationships that may be used for the included parameter.
Responses 404 order book does not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/order_book/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "BASE84651:QUOTE899:0:f:66110000" ,
"type" : "order-book-entries" ,
"attributes" :
{ "is_buy" : false ,
"price" : "33.050000" ,
"base_amount" : "33.050000" ,
"quote_amount" : "1092.302500" ,
"cumulative_base_amount" : "59.153000" ,
"cumulative_quote_amount" : "5813.004120" ,
"created_at" : "2012-11-01T22:08:41+00:00"
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } } ] , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "value" : 1 ,
"name" : "General"
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/order_book/0?include=base_asset&page[number]=2&page[limit]=15" ,
"self" : "/v3/order_book/0?include=base_asset&page[number]=1&page[limit]=15"
} }
OrderBook by ID Returns the list of placed offers without private details.
path Parameters id required
string
Example: "BTC:ETH:0"
ID of the resource, formatted as base:quote:order_book_id, where order_book_id is 0 for secondary market, sale ID otherwise
query Parameters max_entriesinteger <uint64>
Example: 10
Defines quantity of entries that will be returned in the response
includestring
Enum: "buy_entries" "sell_entries" "base_asset" "quote_asset"
Relationships that may be used for the included parameter.
Responses 404 order book does not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/order_books/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "BTC:ETH:0" ,
"type" : "order-books" ,
"relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , } } , "included" :
[
{ "id" : "BASE84651:QUOTE899:0:f:66110000" ,
"type" : "order-book-entries" ,
"attributes" :
{ "is_buy" : false ,
"price" : "33.050000" ,
"base_amount" : "33.050000" ,
"quote_amount" : "1092.302500" ,
"cumulative_base_amount" : "59.153000" ,
"cumulative_quote_amount" : "5813.004120" ,
"created_at" : "2012-11-01T22:08:41+00:00"
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } } ] }
Create Sale Request List Allows getting a filtered list of CreateSaleRequest with details
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.base_asset]string
Filters sale requests by base asset.
filter[request_details.default_quote_asset]string
Filters sale requests by a default quote asset.
includestring
Enum: "request_details" "request_details.base_asset" "request_details.default_quote_asset" "request_details.quote_assets"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
<<<<<<< HEAD
404 requests do not exist
get /v3/create_sale_requests TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_sale_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "default_quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_assets" :
{ "data" :
[
{ "id" : "USD" ,
"type" : "assets"
} ] } } , "attributes" :
{ "access_definition_type" : "string" ,
"base_asset_for_hard_cap" : "1000.123456" ,
"soft_cap" : "123.678902" ,
"hard_cap" : "123.678901" ,
"start_time" : "2012-11-01T22:08:41+00:00" ,
"end_time" : "2012-11-01T22:08:41+00:00" ,
"sale_type" : 2 ,
"creator_details" : { }
} } ] , "links" :
{ "next" : "/v3/create_sale_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_sale_requests?include=details&page[number]=1&page[limit]=15"
} }
Create Sale Request by ID Allows getting CreateSale by ID
=======
404 request does not exist
get /v3/create_sale_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_sale_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
Create Sale Request List Allows getting a filtered list of CreateSaleRequest with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.base_asset]string
Filters create_sale requests by base asset.
filter[request_details.default_quote_asset]string
Filters create_sale requests by default quote asset.
includestring
Enum: "request_details" "request_details.base_asset" "request_details.default_quote_asset" "request_details.quote_assets"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
<<<<<<< HEAD
404 request does not exist
get /v3/create_sale_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_sale_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "default_quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_assets" :
{ "data" :
[
{ "id" : "USD" ,
"type" : "assets"
} ] } } , "attributes" :
{ "access_definition_type" : "string" ,
"base_asset_for_hard_cap" : "1000.123456" ,
"soft_cap" : "123.678902" ,
"hard_cap" : "123.678901" ,
"start_time" : "2012-11-01T22:08:41+00:00" ,
"end_time" : "2012-11-01T22:08:41+00:00" ,
"sale_type" : 2 ,
"creator_details" : { }
} } ] }
Sale by ID For Account Allows getting Sale with corresponding details.
=======
404 requests do not exist
get /v3/create_sale_requests TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_sale_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/create_sale_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_sale_requests?include=details&page[number]=1&page[limit]=15"
} }
Sale by ID Allows getting Sale with corresponding details.
path Parameters id required
integer <int64>
Unique identifier of a sale
query Parameters includestring
Example: "base_asset,default_quote_asset"
Relationships that may be used for the included parameter.
Responses 404 such a sale does not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/sales/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "5" ,
"type" : "sales" ,
"attributes" :
{ "base_hard_cap" : "140000.000000" ,
"start_time" : "2012-11-01T22:08:41+00:00" ,
"end_time" : "2012-11-01T22:08:41+00:00" ,
"sale_type" : 2 ,
"sale_state" : 2 ,
"access_definition_type" : "string" ,
"details" : { }
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "default_quote_asset" :
{ } } } , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "value" : 1 ,
"name" : "General"
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] }
Sale by ID For Account Allows getting Sale with corresponding details.
>>>>>>> master
🔒 Account owner's signature is needed
path Parameters id required
string
Unique identifier of an account
sale_id required
integer <int64>
Unique identifier of a sale
query Parameters includestring
Example: "base_asset,default_quote_asset"
Relationships that may be used for the included parameter.
Responses 404 sale does not exist or account is not allowed to participate in it
get /v3/accounts/{id}/sales/{sale_id} TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/accounts/{id}/sales/{sale_id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "5" ,
"type" : "sales" ,
"attributes" :
{ "base_hard_cap" : "140000.000000" ,
"start_time" : "2012-11-01T22:08:41+00:00" ,
"end_time" : "2012-11-01T22:08:41+00:00" ,
"sale_type" : 2 ,
"sale_state" : 2 ,
"access_definition_type" : "string" ,
"details" : { }
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_assets" :
{ "data" :
[
{ "id" : "USD" ,
"type" : "assets"
} ] } , "default_quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } } , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "name" : "string" ,
"value" : 2
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] }
Sale List For Account Allows getting a filtered list of Sale with corresponding details into which account can invest.
🔒 Account owner's signature is needed
path Parameters id required
string
Unique identifier of an account
query Parameters filter[owner]string
Filters sales by a specified owner's account address.
=======
https://api.achilles.tokend.io /v3/accounts/{id}/sales/{sale_id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "5" ,
"type" : "sales" ,
"attributes" :
{ "base_hard_cap" : "140000.000000" ,
"start_time" : "2012-11-01T22:08:41+00:00" ,
"end_time" : "2012-11-01T22:08:41+00:00" ,
"sale_type" : 2 ,
"sale_state" : 2 ,
"access_definition_type" : "string" ,
"details" : { }
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "default_quote_asset" :
{ } } } , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "value" : 1 ,
"name" : "General"
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] }
Sale List Allows getting a filtered list of Sale with corresponding details.
query Parameters filter[owner]string
Filters sales by a specified owner's account address.
>>>>>>> master
filter[min_start_time]string <date-time>
Example: "2012-10-30T22:08:41+00:00"
Filters sales by a specified minimum start time of the sale.
filter[min_end_time]string <date-time>
Example: "2012-10-30T22:08:41+00:00"
Filters sales by a specified minimum end time of the sale.
filter[max_start_time]string <date-time>
Example: "2012-10-30T22:08:41+00:00"
Filters sales by a specified maximal start time of the sale.
filter[max_end_time]string <date-time>
Example: "2012-10-30T22:08:41+00:00"
Filters sales by a specified maximal end time of the sale.
filter[state]integer
Example: 1
Filters sales by a specified sale state.
Available sale states:
1 - open
2 - closed
3 - cancelled
filter[max_soft_cap]number <float>
Example: "1.000000"
Filters sales by specified maximum soft cap of the sale.
filter[max_hard_cap]number <float>
Example: "3.000000"
Filters sales by specified maximum hard cap of the sale.
filter[min_soft_cap]number <float>
Example: "1.000000"
Filters sales by specified minimum soft cap of the sale.
filter[min_hard_cap]number <float>
Example: "3.000000"
Filters sales by specified minimum hard cap of the sale.
filter[base_asset]string
Example: "BTC36174"
Filters sales by a specified base asset of the sale.
filter[sale_type]integer
Example: 1
Filters sales by a specified sale type.
Available sale types:
1 - basic sale
2 - crowdfunding sale
3 - fixed price sale
includestring
Enum: "base_asset" "quote_assets" "default_quote_asset"
Relationships that may be used for the included parameter.
page[cursor]integer >= 0
Cursor point to the end of the previous page
page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 400 bad input parameter
<<<<<<< HEAD
get /v3/accounts/{id}/sales TokenD Developer Environment
https://api.achilles.tokend.io /v3/accounts/{id}/sales
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "5" ,
"type" : "sales" ,
"attributes" :
{ "base_hard_cap" : "140000.000000" ,
"start_time" : "2012-11-01T22:08:41+00:00" ,
"end_time" : "2012-11-01T22:08:41+00:00" ,
"sale_type" : 2 ,
"sale_state" : 2 ,
"access_definition_type" : "string" ,
"details" : { }
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_assets" :
{ "data" :
[
{ "id" : "USD" ,
"type" : "assets"
} ] } , "default_quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } } ] , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "name" : "string" ,
"value" : 2
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/accounts/{id}/sales?include=default_quote_asset&?page[cursor]=1&page[limit]=15" ,
"self" : "/v3/accounts/{id}/sales?include=default_quote_asset&?page[cursor]=1&page[limit]=15"
} }
Sale List Allows getting a filtered list of Sale with corresponding details.
query Parameters filter[owner]string
Filters sales by a specified owner's account address.
=======
TokenD Developer Environment
https://api.achilles.tokend.io /v3/sales
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "5" ,
"type" : "sales" ,
"attributes" :
{ "base_hard_cap" : "140000.000000" ,
"start_time" : "2012-11-01T22:08:41+00:00" ,
"end_time" : "2012-11-01T22:08:41+00:00" ,
"sale_type" : 2 ,
"sale_state" : 2 ,
"access_definition_type" : "string" ,
"details" : { }
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "default_quote_asset" :
{ } } } ] , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "value" : 1 ,
"name" : "General"
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/sales?include=default_quote_asset&page[number]=2&page[limit]=15" ,
"self" : "/v3/sales?include=default_quote_asset&page[number]=1&page[limit]=15"
} }
Sale List For Account Allows getting a filtered list of Sale with corresponding details into which account can invest.
🔒 Account owner's signature is needed
path Parameters id required
string
Unique identifier of an account
query Parameters filter[owner]string
Filters sales by a specified owner's account address.
>>>>>>> master
filter[min_start_time]string <date-time>
Example: "2012-10-30T22:08:41+00:00"
Filters sales by a specified minimum start time of the sale.
filter[min_end_time]string <date-time>
Example: "2012-10-30T22:08:41+00:00"
Filters sales by a specified minimum end time of the sale.
filter[max_start_time]string <date-time>
Example: "2012-10-30T22:08:41+00:00"
Filters sales by a specified maximal start time of the sale.
filter[max_end_time]string <date-time>
Example: "2012-10-30T22:08:41+00:00"
Filters sales by a specified maximal end time of the sale.
filter[state]integer
Example: 1
Filters sales by a specified sale state.
Available sale states:
1 - open
2 - closed
3 - cancelled
filter[max_soft_cap]number <float>
Example: "1.000000"
Filters sales by specified maximum soft cap of the sale.
filter[max_hard_cap]number <float>
Example: "3.000000"
Filters sales by specified maximum hard cap of the sale.
filter[min_soft_cap]number <float>
Example: "1.000000"
Filters sales by specified minimum soft cap of the sale.
filter[min_hard_cap]number <float>
Example: "3.000000"
Filters sales by specified minimum hard cap of the sale.
filter[base_asset]string
Example: "BTC36174"
Filters sales by a specified base asset of the sale.
filter[sale_type]integer
Example: 1
Filters sales by a specified sale type.
Available sale types:
1 - basic sale
2 - crowdfunding sale
3 - fixed price sale
includestring
Enum: "base_asset" "quote_assets" "default_quote_asset"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 400 bad input parameter
<<<<<<< HEAD
TokenD Developer Environment
https://api.achilles.tokend.io /v3/sales
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "5" ,
"type" : "sales" ,
"attributes" :
{ "base_hard_cap" : "140000.000000" ,
"start_time" : "2012-11-01T22:08:41+00:00" ,
"end_time" : "2012-11-01T22:08:41+00:00" ,
"sale_type" : 2 ,
"sale_state" : 2 ,
"access_definition_type" : "string" ,
"details" : { }
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_assets" :
{ "data" :
[
{ "id" : "USD" ,
"type" : "assets"
} ] } , "default_quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } } ] , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "name" : "string" ,
"value" : 2
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/sales?include=default_quote_asset&page[number]=2&page[limit]=15" ,
"self" : "/v3/sales?include=default_quote_asset&page[number]=1&page[limit]=15"
} }
Participations for the sale Allows getting participation for sale.
=======
get /v3/accounts/{id}/sales TokenD Developer Environment
https://api.achilles.tokend.io /v3/accounts/{id}/sales
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "5" ,
"type" : "sales" ,
"attributes" :
{ "base_hard_cap" : "140000.000000" ,
"start_time" : "2012-11-01T22:08:41+00:00" ,
"end_time" : "2012-11-01T22:08:41+00:00" ,
"sale_type" : 2 ,
"sale_state" : 2 ,
"access_definition_type" : "string" ,
"details" : { }
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "default_quote_asset" :
{ } } } ] , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "value" : 1 ,
"name" : "General"
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/accounts/{id}/sales?include=default_quote_asset&?page[cursor]=1&page[limit]=15" ,
"self" : "/v3/accounts/{id}/sales?include=default_quote_asset&?page[cursor]=1&page[limit]=15"
} }
Participations for the sale Allows getting participation for sale.
>>>>>>> master
🔒 Admin or sale owner signature is required.
path Parameters id required
integer <int64>
Example: 10
Unique identifier of a sale
query Parameters filter[participant]string
Filters sale participation by a specified participants's account address.
filter[quote_asset]string
Example: "BTC36174"
Filters sale participations by a specified quote asset.
includestring
Enum: "base_asset" "quote_asset"
Relationships that may be used for the included parameter.
page[cursor]integer >= 0
Cursor point to the end of the previous page
page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
get /v3/sales/{id}/relationships/participation TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/sales/{id}/relationships/participation
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "name" : "string" ,
"value" : 2
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/sales/{id}/relationships/participation?page[cursor]=1&page[limit]=15" ,
"self" : "/v3/sales/{id}/relationships/participation?page[cursor]=1&page[limit]=15"
} }
Whitelist for sale Allows getting whitelist for sale.
=======
https://api.achilles.tokend.io /v3/sales/{id}/relationships/participation
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "value" : 1 ,
"name" : "General"
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] , "links" :
{ "next" : "/v3/sales/{id}/relationships/participation?page[cursor]=1&page[limit]=15" ,
"self" : "/v3/sales/{id}/relationships/participation?page[cursor]=1&page[limit]=15"
} }
Whitelist for sale Allows getting whitelist for sale.
>>>>>>> master
🔒 Admin or sale owner signature is required.
path Parameters id required
integer <int64>
Example: 10
Unique identifier of a sale
query Parameters filter[address]string <valid accountID>
Example: "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH"
Filters entries by account address where they applied
page[cursor]integer >= 0
Cursor point to the end of the previous page
page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 whitelist does not exist
get /v3/sales/{id}/relationships/whitelist TokenD Developer Environment
https://api.achilles.tokend.io /v3/sales/{id}/relationships/whitelist
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "links" :
{ "next" : "/v3/sales/{id}/relationships/whitelist?page[cursor]=1&page[limit]=15" ,
"self" : "/v3/sales/{id}/relationships/whitelist?page[cursor]=1&page[limit]=15"
} }
Sale by ID Allows getting Sale with corresponding details.
path Parameters id required
integer <int64>
Unique identifier of a sale
query Parameters includestring
Example: "base_asset,default_quote_asset"
Relationships that may be used for the included parameter.
Responses 404 such a sale does not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/sales/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "5" ,
"type" : "sales" ,
"attributes" :
{ "base_hard_cap" : "140000.000000" ,
"start_time" : "2012-11-01T22:08:41+00:00" ,
"end_time" : "2012-11-01T22:08:41+00:00" ,
"sale_type" : 2 ,
"sale_state" : 2 ,
"access_definition_type" : "string" ,
"details" : { }
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_assets" :
{ "data" :
[
{ "id" : "USD" ,
"type" : "assets"
} ] } , "default_quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } } , "included" :
[
{ "id" : "USD" ,
"type" : "assets" ,
"attributes" :
{ "pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.000001" ,
"available_for_issuance" : "20.000000" ,
"issued" : "10.000000" ,
"pending_issuance" : "123.000123" ,
"policies" :
{ "value" : 4 ,
"flags" :
[
{ "name" : "string" ,
"value" : 2
} ] } , "trailing_digits" : 2 ,
"type" : 2 ,
"details" : { }
} } ] }
Update Sale Details List Allows getting a filtered list of UpdateSaleDetailsRequest with details
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
includestring
Enum: "request_details" "request_details.sale"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
<<<<<<< HEAD
404 requests do not exist
get /v3/update_sale_details_requests TokenD Developer Environment
https://api.achilles.tokend.io /v3/update_sale_details_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "sale" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , } ] , "links" :
{ "next" : "/v3/update_sale_details_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/update_sale_details_requests?include=details&page[number]=1&page[limit]=15"
} }
Update Sale Details by ID Allows getting UpdateSaleDetails by ID
=======
404 request does not exist
get /v3/update_sale_details_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/update_sale_details_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
Update Sale Details List Allows getting a filtered list of UpdateSaleDetailsRequest with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
includestring
Enum: "request_details" "request_details.sale"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
<<<<<<< HEAD
404 request does not exist
get /v3/update_sale_details_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/update_sale_details_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "sale" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , } ] }
Match List Allows getting a filtered list of Match with corresponding details.
=======
404 requests do not exist
get /v3/update_sale_details_requests TokenD Developer Environment
https://api.achilles.tokend.io /v3/update_sale_details_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/update_sale_details_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/update_sale_details_requests?include=details&page[number]=1&page[limit]=15"
} }
Match List Allows getting a filtered list of Match with corresponding details.
>>>>>>> master
query Parameters filter[base_asset] required
string <valid assetCode>
Example: "BTC"
Filters matches by specified base asset code
filter[quote_asset] required
string <valid assetCode>
Example: "ETH"
Filters matches by specified quote asset code
filter[order_book] required
number <int64>
Example: 2
Filters offers by specified order book ID
Defines whether offers are for sale or for trade
(0 - secondary market, saleId - for specific sale)
page[cursor]integer >= 0
Cursor point to the end of the previous page
page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 404 order book does not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/matches
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "17179869186" ,
"type" : "matches" ,
"attributes" :
{ "created_at" : "2018-11-01T22:11:41Z" ,
"quote_amount" : "34.551851" ,
"base_amount" : "55.001291" ,
"price" : "51.150509"
} , "relationships" :
{ "base_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } , "quote_asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } } ] , "included" : [ ] ,
"links" :
{ "next" : "/v3/matches?include=asset&page[number]=2&page[limit]=15" ,
"self" : "/v3/matches?include=asset&page[number]=1&page[limit]=15"
} }
PreIssuance Request List Allows getting a filtered list of AssetCreateRequest with details
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.asset]string
Filters preissuance create requests by asset code.
includestring
Enum: "request_details" "request_details.asset"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
<<<<<<< HEAD
404 requests do not exist
get /v3/create_pre_issuance_requests TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_pre_issuance_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } , "attributes" :
{ "amount" : "123214.123456" ,
"signature" : "a343e3cbcc72928a571778f77bf2554eb5b72c79ce28bbc9d3325c60c21e5241" ,
"reference" : "a343e3cbcc72928a571778f77bf2554eb5b72c79ce28bbc9d3325c60c2123451" ,
"creator_details" : { }
} } ] , "links" :
{ "next" : "/v3/create_pre_issuance_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_pre_issuance_requests?include=details&page[number]=1&page[limit]=15"
} }
PreIssuance Request by ID Allows getting CreatePreIssuance by ID
=======
404 request does not exist
get /v3/create_pre_issuance_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_pre_issuance_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
PreIssuance Request List Allows getting a filtered list of AssetCreateRequest with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.asset]string
Filters preissuance create requests by asset code.
includestring
Enum: "request_details" "request_details.asset"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
<<<<<<< HEAD
404 request does not exist
get /v3/create_pre_issuance_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_pre_issuance_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } , "attributes" :
{ "amount" : "123214.123456" ,
"signature" : "a343e3cbcc72928a571778f77bf2554eb5b72c79ce28bbc9d3325c60c21e5241" ,
"reference" : "a343e3cbcc72928a571778f77bf2554eb5b72c79ce28bbc9d3325c60c2123451" ,
"creator_details" : { }
} } ] }
KeyValueEntry List Allows getting KeyValueEntry with corresponding details.
=======
404 requests do not exist
get /v3/create_pre_issuance_requests TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_pre_issuance_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/create_pre_issuance_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_pre_issuance_requests?include=details&page[number]=1&page[limit]=15"
} }
KeyValueEntry by ID Allows getting KeyValueEntry with corresponding details.
path Parameters key required
string
Example: "max_contracts_count"
Unique identifier of the key-value entry
Responses 200 key-value entry exists
404 key-value entry does not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/key_values/{key}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "max_contracts_count" ,
"type" : "key-value-entries" ,
"attributes" :
{ "value" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} , "u32" : 1
} } } }
KeyValueEntry List Allows getting KeyValueEntry with corresponding details.
>>>>>>> master
query Parameters page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 200 KeyValue entries exist
TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/key_values
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "max_contracts_count" ,
"type" : "key-value-entries" ,
"attributes" :
{ "value" :
{ "type" :
{ "name" : "uint32" ,
"value" : 1
} , "u32" : 1
} } } ] , "included" : [ ] ,
"links" :
{ "next" : "/v3/key_values?page[number]=2&page[limit]=15" ,
"self" : "/v3/key_values?page[number]=1&page[limit]=15"
} }
KeyValueEntry by ID Allows getting KeyValueEntry with corresponding details.
path Parameters key required
string
Example: "max_contracts_count"
Unique identifier of the key-value entry
Responses 200 key-value entry exists
404 key-value entry does not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/key_values/{key}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "max_contracts_count" ,
"type" : "key-value-entries" ,
"attributes" :
{ "value" :
{ "type" :
{ "name" : "uint32" ,
"value" : 1
} , "u32" : 1
} } } }
Current license info Allows getting current license information
=======
https://api.achilles.tokend.io /v3/key_values
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "max_contracts_count" ,
"type" : "key-value-entries" ,
"attributes" :
{ "value" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} , "u32" : 1
} } } ] , "included" : [ ] ,
"links" :
{ "next" : "/v3/key_values?page[number]=2&page[limit]=15" ,
"self" : "/v3/key_values?page[number]=1&page[limit]=15"
} }
Current license info Allows getting current license information
>>>>>>> master
Responses 200 succesfully retrieved license
TokenD Developer Environment
https://api.achilles.tokend.io /v3/license
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "id" : "12" ,
"type" : "license-info" ,
}
Create Poll Request List Allows getting a filtered list of CreatePollRequest with details
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.result_provider]string
Filters poll requests by result provider.
filter[request_details.vote_confirmation_required]string
Filters poll requests by a voteConfirmationRequired property.
filter[request_details.permission_type]string
Filters poll requests by permission type.
includestring
Value: "request_details"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
<<<<<<< HEAD
404 requests do not exist
get /v3/create_poll_requests TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_poll_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "permission_type" : 4 ,
"number_of_choices" : 2 ,
"start_time" : "2012-11-01T22:08:41Z" ,
"end_time" : "2012-11-01T22:08:41Z" ,
"vote_confirmation_required" : true ,
"poll_data" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} } , "creator_details" : { }
} } ] , "links" :
{ "next" : "/v3/create_poll_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_poll_requests?include=details&page[number]=1&page[limit]=15"
} }
Create Poll Request by ID Allows getting CreatePoll by ID
=======
404 request does not exist
get /v3/create_poll_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_poll_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
Create Poll Request List Allows getting a filtered list of CreatePollRequest with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
filter[request_details.permission_type]uint64
Filters create_poll requests by permission type.
filter[request_details.vote_confirmation_required]boolean
Filters create_poll requests by vote_confirmation_required property.
includestring
Value: "request_details"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
<<<<<<< HEAD
404 request does not exist
get /v3/create_poll_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_poll_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "permission_type" : 4 ,
"number_of_choices" : 2 ,
"start_time" : "2012-11-01T22:08:41Z" ,
"end_time" : "2012-11-01T22:08:41Z" ,
"vote_confirmation_required" : true ,
"poll_data" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} } , "creator_details" : { }
} } ] }
Polls list Allows getting a filtered list of Polls with corresponding details.
=======
404 requests do not exist
get /v3/create_poll_requests TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_poll_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/create_poll_requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/create_poll_requests?include=details&page[number]=1&page[limit]=15"
} }
Poll by ID Allows getting Poll with corresponding details.
🔒 Admin, poll result provider or poll owner signature is required if outcome should be included.
path Parameters id required
integer <int64>
Example: 10
Unique identifier of a poll
query Parameters includestring
Enum: "participation" "participation.votes"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
TokenD Developer Environment
https://api.achilles.tokend.io /v3/polls/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "10" ,
"type" : "polls" ,
"relationships" :
{ "participation" :
{ "data" :
{ "id" : "10" ,
"type" : "poll-outcome"
} } } , "attributes" :
{ "permission_type" : 4 ,
"number_of_choices" : 2 ,
"start_time" : "2012-11-01T22:08:41Z" ,
"end_time" : "2012-11-01T22:08:41Z" ,
"vote_confirmation_required" : true ,
"poll_state" :
{ "value" : 1 ,
"name" : "General"
} , "poll_data" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} } , "creator_details" : { }
} } , "included" : [ ]
}
Polls list Allows getting a filtered list of Polls with corresponding details.
>>>>>>> master
🔒 Depending on the case, different signatures are required:
if no filters are applied, admin signature is required.
if filter by owner is applied, signature of owner is required
query Parameters filter[owner]string <valid accountID>
Example: "GAULFBQKQTFHHHZEIRMYVCGTY47FKWEW7P2BY2YT45HAEODAIJUJH23T"
Filters polls by specified owner id
filter[result_provider]string <valid accountID>
Example: "GBULFBQKQTFHHHZEIRMYVCGTY47FKWEW7P2BY2YT45HAEODAIJUJH23E"
Filters polls by specified result provider id
filter[permission_type]any
Filters polls by specified permission type
filter[poll_type]integer
Example: 0
Filters polls by a specified poll type.
Available poll types:
filter[vote_confirmation]boolean
Example: false
Filters polls by VoteConfirmationRequired property
filter[min_start_time]string <date-time>
Example: "2012-10-30T22:08:41+00:00"
Filters polls by a specified minimum start time of the poll.
filter[min_end_time]string <date-time>
Example: "2012-10-30T22:08:41+00:00"
Filters polls by a specified minimum end time of the poll.
filter[max_start_time]string <date-time>
Example: "2012-10-30T22:08:41+00:00"
Filters polls by a specified maximal start time of the poll.
filter[max_end_time]string <date-time>
Example: "2012-10-30T22:08:41+00:00"
Filters polls by a specified maximal end time of the poll.
filter[state]integer
Example: 1
Filters polls by a specified poll state.
Available poll states:
1 - open
2 - passed
3 - failed
4 - cancelled
page[cursor]integer >= 0
Cursor point to the end of the previous page
page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/polls
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "10" ,
"type" : "polls" ,
"relationships" :
{ "participation" :
{ "data" :
{ "id" : "10" ,
"type" : "poll-outcome"
} } } , "attributes" :
{ "permission_type" : 4 ,
"number_of_choices" : 2 ,
"start_time" : "2012-11-01T22:08:41Z" ,
"end_time" : "2012-11-01T22:08:41Z" ,
"vote_confirmation_required" : true ,
"poll_state" : 0 ,
"poll_data" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} } , "creator_details" : { }
} } ] , "included" : [ ] ,
}
Poll by ID Allows getting Poll with corresponding details.
🔒 Admin, poll result provider or poll owner signature is required if outcome should be included.
path Parameters id required
integer <int64>
Example: 10
Unique identifier of a poll
query Parameters includestring
Enum: "participation" "participation.votes"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
TokenD Developer Environment
https://api.achilles.tokend.io /v3/polls/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "10" ,
"type" : "polls" ,
"relationships" :
{ "participation" :
{ "data" :
{ "id" : "10" ,
"type" : "poll-outcome"
} } } , "attributes" :
{ "permission_type" : 4 ,
"number_of_choices" : 2 ,
"start_time" : "2012-11-01T22:08:41Z" ,
"end_time" : "2012-11-01T22:08:41Z" ,
"vote_confirmation_required" : true ,
"poll_state" : 0 ,
"poll_data" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} } , "creator_details" : { }
} } , "included" : [ ]
}
Votes of specific voter Allows getting a filtered list of Votes with corresponding details.
=======
https://api.achilles.tokend.io /v3/polls
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "10" ,
"type" : "polls" ,
"relationships" :
{ "participation" :
{ "data" :
{ "id" : "10" ,
"type" : "poll-outcome"
} } } , "attributes" :
{ "permission_type" : 4 ,
"number_of_choices" : 2 ,
"start_time" : "2012-11-01T22:08:41Z" ,
"end_time" : "2012-11-01T22:08:41Z" ,
"vote_confirmation_required" : true ,
"poll_state" :
{ "value" : 1 ,
"name" : "General"
} , "poll_data" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} } , "creator_details" : { }
} } ] , "included" : [ ] ,
}
Vote by ID Allows getting Vote with corresponding details.
🔒 Admin, voter, poll owner or poll result provider signature is required.
path Parameters id required
integer <int64>
Example: 10
Unique identifier of a poll
voter required
string
Example: "GAULFBQKQTFHHHZEIRMYVCGTY47FKWEW7P2BY2YT45HAEODAIJUJH23T"
Unique identifier of a voter account
query Parameters includestring
Value: "poll"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
get /v3/polls/{id}/relationships/votes/{voter} TokenD Developer Environment
https://api.achilles.tokend.io /v3/polls/{id}/relationships/votes/{voter}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "10" ,
"type" : "polls" ,
"relationships" :
{ "participation" :
{ "data" :
{ "id" : "10" ,
"type" : "poll-outcome"
} } } , "attributes" :
{ "permission_type" : 4 ,
"number_of_choices" : 2 ,
"start_time" : "2012-11-01T22:08:41Z" ,
"end_time" : "2012-11-01T22:08:41Z" ,
"vote_confirmation_required" : true ,
"poll_state" :
{ "value" : 1 ,
"name" : "General"
} , "poll_data" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} } , "creator_details" : { }
} } ] }
Votes of specific voter Allows getting a filtered list of Votes with corresponding details.
>>>>>>> master
🔒 Admin or voter signature is required.
path Parameters voter required
string
Example: "GA67BUDBYDGCVCL6EKPDAREG5IPLHSROF6QJX7MLS2BQJZJDO6FCZAKE"
query Parameters includestring
Enum: "polls" "account"
Relationships that may be used for the included parameter.
polls will include all the polls related to votes
account will include voter account
page[cursor]integer >= 0
Cursor point to the end of the previous page
page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/votes/{voter}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "10" ,
"type" : "polls" ,
"relationships" :
{ "participation" :
{ "data" :
{ "id" : "10" ,
"type" : "poll-outcome"
} } } , "attributes" :
{ "permission_type" : 4 ,
"number_of_choices" : 2 ,
"start_time" : "2012-11-01T22:08:41Z" ,
"end_time" : "2012-11-01T22:08:41Z" ,
"vote_confirmation_required" : true ,
"poll_state" : 0 ,
"poll_data" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} } , "creator_details" : { }
} } ] , "links" :
{ "next" : "/v3/votes/GA67BUDBYDGCVCL6EKPDAREG5IPLHSROF6QJX7MLS2BQJZJDO6FCZAKE?page[cursor]=22312312&page[limit]=15" ,
"self" : "/v3/votes/GA67BUDBYDGCVCL6EKPDAREG5IPLHSROF6QJX7MLS2BQJZJDO6FCZAKE?page[cursor]=12313123&page[limit]=15"
} }
Votes list Allows getting a filtered list of Votes with corresponding details.
=======
https://api.achilles.tokend.io /v3/votes/{voter}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "10" ,
"type" : "polls" ,
"relationships" :
{ "participation" :
{ "data" :
{ "id" : "10" ,
"type" : "poll-outcome"
} } } , "attributes" :
{ "permission_type" : 4 ,
"number_of_choices" : 2 ,
"start_time" : "2012-11-01T22:08:41Z" ,
"end_time" : "2012-11-01T22:08:41Z" ,
"vote_confirmation_required" : true ,
"poll_state" :
{ "value" : 1 ,
"name" : "General"
} , "poll_data" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} } , "creator_details" : { }
} } ] , "links" :
{ "next" : "/v3/votes/GA67BUDBYDGCVCL6EKPDAREG5IPLHSROF6QJX7MLS2BQJZJDO6FCZAKE?page[cursor]=22312312&page[limit]=15" ,
"self" : "/v3/votes/GA67BUDBYDGCVCL6EKPDAREG5IPLHSROF6QJX7MLS2BQJZJDO6FCZAKE?page[cursor]=12313123&page[limit]=15"
} }
Votes list Allows getting a filtered list of Votes with corresponding details.
>>>>>>> master
🔒 Admin, poll result provider or poll owner signature is required.
path Parameters id required
integer <int64>
Example: 10
Unique identifier of a poll
query Parameters includestring
Value: "poll"
Relationships that may be used for the included parameter.
page[cursor]integer >= 0
Cursor point to the end of the previous page
page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
get /v3/polls/{id}/relationships/votes TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /v3/polls/{id}/relationships/votes
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "10" ,
"type" : "polls" ,
"relationships" :
{ "participation" :
{ "data" :
{ "id" : "10" ,
"type" : "poll-outcome"
} } } , "attributes" :
{ "permission_type" : 4 ,
"number_of_choices" : 2 ,
"start_time" : "2012-11-01T22:08:41Z" ,
"end_time" : "2012-11-01T22:08:41Z" ,
"vote_confirmation_required" : true ,
"poll_state" : 0 ,
"poll_data" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} } , "creator_details" : { }
} } ] , "links" :
{ "next" : "/v3/votes?page[cursor]=22312312&page[limit]=15" ,
"self" : "/v3/votes?page[cursor]=12313123&page[limit]=15"
} }
Vote by ID Allows getting Vote with corresponding details.
🔒 Admin, voter, poll owner or poll result provider signature is required.
path Parameters id required
integer <int64>
Example: 10
Unique identifier of a poll
voter required
string
Example: "GAULFBQKQTFHHHZEIRMYVCGTY47FKWEW7P2BY2YT45HAEODAIJUJH23T"
Unique identifier of a voter account
query Parameters includestring
Value: "poll"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
get /v3/polls/{id}/relationships/votes/{voter} TokenD Developer Environment
https://api.achilles.tokend.io /v3/polls/{id}/relationships/votes/{voter}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "10" ,
"type" : "polls" ,
"relationships" :
{ "participation" :
{ "data" :
{ "id" : "10" ,
"type" : "poll-outcome"
} } } , "attributes" :
{ "permission_type" : 4 ,
"number_of_choices" : 2 ,
"start_time" : "2012-11-01T22:08:41Z" ,
"end_time" : "2012-11-01T22:08:41Z" ,
"vote_confirmation_required" : true ,
"poll_state" : 0 ,
"poll_data" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} } , "creator_details" : { }
} } ] }
Create Payment Request List Allows getting a filtered list of CreatePayment with details
=======
https://api.achilles.tokend.io /v3/polls/{id}/relationships/votes
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "10" ,
"type" : "polls" ,
"relationships" :
{ "participation" :
{ "data" :
{ "id" : "10" ,
"type" : "poll-outcome"
} } } , "attributes" :
{ "permission_type" : 4 ,
"number_of_choices" : 2 ,
"start_time" : "2012-11-01T22:08:41Z" ,
"end_time" : "2012-11-01T22:08:41Z" ,
"vote_confirmation_required" : true ,
"poll_state" :
{ "value" : 1 ,
"name" : "General"
} , "poll_data" :
{ "type" :
{ "value" : 1 ,
"name" : "General"
} } , "creator_details" : { }
} } ] , "links" :
{ "next" : "/v3/votes?page[cursor]=22312312&page[limit]=15" ,
"self" : "/v3/votes?page[cursor]=12313123&page[limit]=15"
} }
Create Payment Request by ID Allows getting CreatePayment request by ID
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
includestring
Value: "request_details"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
<<<<<<< HEAD
get /v3/create_payment_requests TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_payment_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
} ] }
Create Payment Request by ID Allows getting CreatePayment request by ID
=======
get /v3/create_payment_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_payment_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
Create Payment Request List Allows getting a filtered list of CreatePayment with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
includestring
Value: "request_details"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
<<<<<<< HEAD
get /v3/create_payment_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_payment_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
} ] }
Manage Offer Request List Allows getting a filtered list of ManageOffer with details
=======
get /v3/create_payment_requests TokenD Developer Environment
https://api.achilles.tokend.io /v3/create_payment_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
Manage Offer Request by ID Allows getting ManageOffer requests by ID
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
includestring
Value: "request_details"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
<<<<<<< HEAD
get /v3/manage_offer_requests TokenD Developer Environment
https://api.achilles.tokend.io /v3/manage_offer_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "offer_id" : 1 ,
"order_book_id" : 0 ,
"base_amount" : "1000.0" ,
"price" : "12.3" ,
"is_buy" : true ,
} } ] }
Manage Offer Request by ID Allows getting ManageOffer requests by ID
=======
get /v3/manage_offer_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/manage_offer_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
Manage Offer Request List Allows getting a filtered list of ManageOffer with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
includestring
Value: "request_details"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 request does not exist
<<<<<<< HEAD
get /v3/manage_offer_requests/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/manage_offer_requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "offer_id" : 1 ,
"order_book_id" : 0 ,
"base_amount" : "1000.0" ,
"price" : "12.3" ,
"is_buy" : true ,
} } ] }
Reviewable Request List Allows getting a filtered list of ReviewableRequest with details
=======
get /v3/manage_offer_requests TokenD Developer Environment
https://api.achilles.tokend.io /v3/manage_offer_requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } , }
Reviewable Request by ID Allows getting ReviewableRequest by ID
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review requests.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[type]integer [ 2 .. 17 ]
Filters requests by their type.
2 - "create_pre_issuance"
3 - "create_issuance"
4 - "create_withdraw"
5 - "create_sale"
6 - "update_limits"
7 - "create_aml_alert"
8 - "change_role"
9 - "update_sale_details"
10 - "create_asset"
11 - "create_invoice"
12 - "manage_contract"
13 - "update_asset"
16 - "create_atomic_swap_bid"
17 - "create_atomic_swap"
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if none of bits is set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
includestring
Value: "request_details"
Relationships that may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
<<<<<<< HEAD
404 requests do not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } , "attributes" :
{ "asset" : "USD" ,
"type" : 1 ,
"policies" : 12 ,
"pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.123456" ,
"initial_preissued_amount" : "1000.123456" ,
"trailing_digits_count" : 2 ,
"creator_details" : { }
} } ] , "links" :
{ "next" : "/v3/requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/requests?include=details&page[number]=1&page[limit]=15"
} }
Reviewable Request by ID Allows getting ReviewableRequest by ID
=======
404 request does not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , }
Reviewable Request List Allows getting a filtered list of ReviewableRequest with details
>>>>>>> master
🔒 Requestor's or reviewer's signature is needed
query Parameters filter[requestor]string
Filters requests by requestor - source of the operation.
filter[reviewer]string
Filters requests by reviewer - account assigned to review request.
filter[state]integer [ 1 .. 5 ]
Filters requests by their state.
1 - pending
2 - canceled
3 - approved
4 - rejected
5 - permanently_rejected
filter[type]integer [ 2 .. 17 ]
Filters requests by their type.
2 - "create_pre_issuance"
3 - "create_issuance"
4 - "create_withdraw"
5 - "create_sale"
6 - "update_limits"
7 - "create_aml_alert"
8 - "change_role"
9 - "update_sale_details"
10 - "create_asset"
11 - "create_invoice"
12 - "manage_contract"
13 - "update_asset"
16 - "create_atomic_swap_bid"
17 - "create_atomic_swap"
filter[pending_tasks]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bit are set.
filter[pending_tasks_not_set]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if all bits not set.
filter[pending_tasks_any_of]integer
Filters requests by existing tasks in pending tasks bit mask. Returns requests if at least one bit is set.
includestring
Value: "request_details"
Relationships that may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
<<<<<<< HEAD
404 request does not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/requests/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "request_details" :
{ "data" :
{ "id" : "12345" ,
"type" : "requests"
} } } , "attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" : 0
} } ] , "included" :
{ "id" : "12345" ,
"type" : "requests" ,
"relationships" :
{ "asset" :
{ "data" :
{ "id" : "USD" ,
"type" : "assets"
} } } , "attributes" :
{ "asset" : "USD" ,
"type" : 1 ,
"policies" : 12 ,
"pre_issuance_asset_signer" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"max_issuance_amount" : "1000.123456" ,
"initial_preissued_amount" : "1000.123456" ,
"trailing_digits_count" : 2 ,
"creator_details" : { }
} } }
Get history Allows to get a filtered list of participants effects
=======
404 requests do not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/requests
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "12345" ,
"type" : "requests" ,
"attributes" :
{ "reject_reason" : "source account underfunded" ,
"hash" : "13935d561f9ec54341243e6afaf0c8bf936928b07f6600204ba8ca550757d0a6" ,
"all_tasks" : 12 ,
"pending_tasks" : 2 ,
"created_at" : "2012-11-01T22:08:41+00:00" ,
"updated_at" : "2012-11-01T22:08:41+00:00" ,
"state" : "pending" ,
"state_i" : 0 ,
"reference" : "719111a51cfc5ad214e4e90ce6610f10e1cba165fd1bc9db73a031352b3bb61c" ,
"external_details" : { } ,
"xdr_type" :
{ "value" : 1 ,
"name" : "General"
} } } ] , "links" :
{ "next" : "/v3/requests?include=details&page[number]=2&page[limit]=15" ,
"self" : "/v3/requests?include=details&page[number]=1&page[limit]=15"
} }
Get history Allows to get a filtered list of participants effects
>>>>>>> master
query Parameters filter[account]string
Filters history by participant account address
filter[balance]string
Filters history by participant's balance
filter[asset]string
Filters history by involved asset
includestring
Enum: "effect" "operation" "operation.details" "asset"
Relationships may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
TokenD Developer Environment
https://api.achilles.tokend.io /v3/history
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "17179869186" ,
"type" : "operations" ,
"relationships" :
{ "tx" :
{ "id" : "17179869186" ,
"type" : "transactions"
} , } , } ] , "links" :
{ "next" : "/v3/history?include=operation.details&page[number]=2&page[limit]=15" ,
"self" : "/v3/history?include=operation.details&page[number]=1&page[limit]=15"
} }
Get movements Allows to get a filtered list of participants effects related to balances only - movements
🔒 Permissions:
Filters
Signature
-
admin
filter[asset]
admin or asset owner
filter[balance], filter[account]
admin or account owner
query Parameters filter[account]string
Filters movements by participant account address
filter[balance]string
Filters movements by participant's balance
filter[asset]string
Filters movements by involved asset
includestring
Enum: "effect" "operation" "operation.details" "asset"
Relationships may be used for the included parameter.
page[number] page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 404 operations do not exist
TokenD Developer Environment
https://api.achilles.tokend.io /v3/movements
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "included" :
[
{ "id" : "17179869186" ,
"type" : "operations" ,
"relationships" :
{ "tx" :
{ "id" : "17179869186" ,
"type" : "transactions"
} , } , } ] , "links" :
{ "next" : "/v3/movements?include=operation.details&page[number]=2&page[limit]=15" ,
"self" : "/v3/movements?include=operation.details&page[number]=1&page[limit]=15"
} }
Get transaction Allows to get transaction by ID or Hash
🔒 Admin account's signature is required.
path Parameters id required
string
ID or Hash of the transaction
query Parameters includestring
Value: "ledger_entry_changes"
Relationships may be used for the included parameter.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 such transaction does not exist
get /v3/transactions/{id} TokenD Developer Environment
https://api.achilles.tokend.io /v3/transactions/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "17179869186" ,
"type" : "transactions" ,
"attributes" :
{ "hash" : "575a8bad0a67378029c778d92eb5367136e89530830ed8275ff20ac80160a80d" ,
"ledger_sequence" : 4 ,
"created_at" : "2019-03-04T18:42:15Z" ,
"envelope_xdr" : "AAAAAEHCX5tmu0fXlkE9GLIOLO185ih5QI7V+PZ1mtb1tnzSA59veKFdUjsAAAAAAAAAAAAAAABchp31A..." ,
"result_xdr" : "AAAAAAAAAAAAAAAAAAAAAQAAAAAAAAALAAAAAAAAAAAAAAABAAAAAQAAAAAAAAAA" ,
"result_meta_xdr" : "AAAAAAAAAAEAAAAMAAAAAwAAAAEAAAAaAAAAAAAAAAEAAAABAAAAAAAAAAEAAAACe30AAAAAAAAAAAAAAAAAAwAAAA..."
} , "relationships" :
{ "operations" :
[
{ "id" : "17179869186" ,
"type" : "operations"
} ] , "ledger_entry_changes" :
[ ] } } , "included" :
[
{ "id" : "17179869186:17179869186:0" ,
"type" : "ledger-entry-changes" ,
} ] }
Get transactions Allows to get a filtered list of transactionsa
🔒 Admin account's signature is required.
query Parameters filter[ledger_entry_changes.entry_types]integer [ 2 .. 35 ]
Filters transactions by ledger entry type they affected (comma-separated multiple values are supported):
2 - account
3 - signer
4 - fee
5 - balance
6 - payment_request
7 - asset
8 - reference_entry
9 - statistics
10 - trust
11 - account_limits
12 - asset_pair
13 - offer_entry
15 - reviewable_request
16 - external_system_account_id
17 - sale
18 - account_kyc
19 - external_system_account_id_pool_entry
20 - key_value
22 - limits_v2
23 - statistics_v2
24 - pending_statistics
25 - contract
26 - account_role
27 - account_rule
28 - atomic_swap_bid
29 - transaction
30 - signer_rule
31 - signer_role
32 - stamp
33 - license
34 - poll
35 - vote
filter[ledger_entry_changes.change_types]integer [ 0 .. 3 ]
description: |
Filters transactions by ledger entry change type they performed (comma-separated multiple values are supported):
0 - created
1 - updated
2 - removed
3 - state
includestring
Value: "ledger_entry_changes"
Relationships may be used for the included parameter.
page[cursor]integer >= 0
Cursor point to the end of the previous page
page[limit]integer [ 1 .. 100 ]
Default: 15
Numbers of items per page to return.
page[order]string
Default: "asc"
Enum: "asc" "desc"
Order of records on the page. If sortingParam is not specified, order of records is by default sorted by ID.
Responses 401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
TokenD Developer Environment
https://api.achilles.tokend.io /v3/transactions
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
[
{ "id" : "17179869186" ,
"type" : "transactions" ,
"attributes" :
{ "hash" : "575a8bad0a67378029c778d92eb5367136e89530830ed8275ff20ac80160a80d" ,
"ledger_sequence" : 4 ,
"created_at" : "2019-03-04T18:42:15Z" ,
"envelope_xdr" : "AAAAAEHCX5tmu0fXlkE9GLIOLO185ih5QI7V+PZ1mtb1tnzSA59veKFdUjsAAAAAAAAAAAAAAABchp31A..." ,
"result_xdr" : "AAAAAAAAAAAAAAAAAAAAAQAAAAAAAAALAAAAAAAAAAAAAAABAAAAAQAAAAAAAAAA" ,
"result_meta_xdr" : "AAAAAAAAAAEAAAAMAAAAAwAAAAEAAAAaAAAAAAAAAAEAAAABAAAAAAAAAAEAAAACe30AAAAAAAAAAAAAAAAAAwAAAA..."
} , "relationships" :
{ "operations" :
[
{ "id" : "17179869186" ,
"type" : "operations"
} ] , "ledger_entry_changes" :
[ ] } } ] , "included" :
[
{ "id" : "17179869186:17179869186:0" ,
"type" : "ledger-entry-changes" ,
} ] , "links" :
{ "next" : "/v3/transactions?include=ledger_entry_changes&page[cursor]=2&page[limit]=15" ,
"self" : "/v3/transactions?include=ledger_entry_changes&page[cursor]=1&page[limit]=15"
} }
Public Key Entry By ID Returns the requested public key with accounts that have signer with such public key
🔒 Admins or public key owner signature is needed
path Parameters id required
string
ID of entry (the public key itself)
Responses 200 public key entry exists
401 either an invalid signature has been provided or a signer has not been authorized to access specified resources
404 public key entry not found
TokenD Developer Environment
https://api.achilles.tokend.io /v3/public_keys/{id}
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "GBSR6JG5AYSAW7HK6EGJFYVIVN54LVGSY3ZLJ6X3IBQZ766EJABCZQTH" ,
"type" : "public-key-entries" ,
} , "included" : [ ]
}
Horizon info Deprecated Allows getting basic info about horizon
Responses 200 succesfully retrieved page
TokenD Developer Environment
<<<<<<< HEAD
https://api.achilles.tokend.io /
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "network_passphrase" : "example network passphrase" ,
"admin_account_id" : "GBA4EX43M25UPV4WIE6RRMQOFTWXZZRIPFAI5VPY6Z2ZVVXVWZ6NEOOB" ,
"master_exchange_name" : "TokenD" ,
"tx_expiration_period" : 0 ,
"current_time" : 0 ,
"precision" : 0 ,
"xdr_revision" : "7e0659466026577a3ea90ff178773fecc4a85dec"
}
Horizon info Allows getting basic info about horizon state and it's dependensies
=======
https://api.achilles.tokend.io /
Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "network_passphrase" : "example network passphrase" ,
"admin_account_id" : "GBA4EX43M25UPV4WIE6RRMQOFTWXZZRIPFAI5VPY6Z2ZVVXVWZ6NEOOB" ,
"master_exchange_name" : "TokenD" ,
"tx_expiration_period" : 0 ,
"current_time" : 0 ,
"precision" : 0 ,
"xdr_revision" : "7e0659466026577a3ea90ff178773fecc4a85dec"
}
Horizon info Allows getting basic info about horizon state and it's dependensies
>>>>>>> master
Responses 200 succesfully retrieved state
TokenD Developer Environment
https://api.achilles.tokend.io /v3/info
Response samples application/vnd.api+json
Copy
Expand all Collapse all
Submit transaction Allows to submit transaction to the network
Request Body schema: application/json tx required
string
base-64 encoded XDR representation of transaction itself
wait_for_ingestboolean
Default: false
defines whether to wait for ingest of transaction or not
Responses 200 successfully submitted
408 request has timed out
500 internal server error
TokenD Developer Environment
https://api.achilles.tokend.io /v3/transactions
Request samples application/json
Copy
Expand all Collapse all Response samples application/vnd.api+json
Copy
Expand all Collapse all
{ "data" :
{ "id" : "17179869186" ,
"type" : "transactions" ,
"attributes" :
{ "hash" : "575a8bad0a67378029c778d92eb5367136e89530830ed8275ff20ac80160a80d" ,
"ledger_sequence" : 4 ,
"created_at" : "2019-03-04T18:42:15Z" ,
"envelope_xdr" : "AAAAAEHCX5tmu0fXlkE9GLIOLO185ih5QI7V+PZ1mtb1tnzSA59veKFdUjsAAAAAAAAAAAAAAABchp31A..." ,
"result_xdr" : "AAAAAAAAAAAAAAAAAAAAAQAAAAAAAAALAAAAAAAAAAAAAAABAAAAAQAAAAAAAAAA" ,
"result_meta_xdr" : "AAAAAAAAAAEAAAAMAAAAAwAAAAEAAAAaAAAAAAAAAAEAAAABAAAAAAAAAAEAAAACe30AAAAAAAAAAAAAAAAAAwAAAA..."
} , "relationships" :
{ "operations" :
[
{ "id" : "17179869186" ,
"type" : "operations"
} ] , "ledger_entry_changes" :
[ ] } } }